<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ReadableInterval xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/goda/time/ReadableInterval.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> *  Copyright 2001-2006 Stephen Colebourne</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *  you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> *  You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> *  Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *  See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> *  limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.goda.time;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * Readable interface for an interval of time between two instants.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * A time interval represents a period of time between two instants.</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * The end instant is always greater than or equal to the start instant.</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * Intervals have a fixed millisecond duration.</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * This is the difference between the start and end instants.</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * The duration is represented separately by {@link ReadableDuration}.</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * As a result, intervals are not comparable.</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * To compare the length of two intervals, you should compare their durations.</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * An interval can also be converted to a {@link ReadablePeriod}.</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * This represents the difference between the start and end points in terms of fields</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * such as years and days.</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * Methods that are passed an interval as a parameter will treat &lt;code&gt;null&lt;/code&gt;</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * as a zero length interval at the current instant in time.</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> *</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * @author Sean Geoghegan</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * @author Brian S O'Neill</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * @author Stephen Colebourne</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> */</em>
<a name="43" href="#43">43</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/goda/time/ReadableInterval.html">ReadableInterval</a> {
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>      <em class="jxr_javadoccomment">/**</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * Gets the chronology of the interval, which is the chronology of the first datetime.</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     *</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @return the chronology of the interval</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     */</em>
<a name="50" href="#50">50</a>      <a href="../../../org/goda/time/Chronology.html">Chronology</a> getChronology();
<a name="51" href="#51">51</a>  
<a name="52" href="#52">52</a>      <em class="jxr_javadoccomment">/**</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     * Gets the start of this time interval which is inclusive.</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     *</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * @return the start of the time interval,</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     *  millisecond instant from 1970-01-01T00:00:00Z</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     */</em>
<a name="58" href="#58">58</a>      <strong class="jxr_keyword">long</strong> getStartMillis();
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>      <em class="jxr_javadoccomment">/**</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * Gets the start of this time interval, which is inclusive, as a DateTime.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     *</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     * @return the start of the time interval</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
<a name="65" href="#65">65</a>      <a href="../../../org/goda/time/DateTime.html">DateTime</a> getStart();
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">     * Gets the end of this time interval which is exclusive.</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">     *</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">     * @return the end of the time interval,</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">     *  millisecond instant from 1970-01-01T00:00:00Z</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">     */</em>
<a name="73" href="#73">73</a>      <strong class="jxr_keyword">long</strong> getEndMillis();
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">     * Gets the end of this time interval, which is exclusive, as a DateTime.</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     *</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * @return the end of the time interval</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     */</em>
<a name="80" href="#80">80</a>      <a href="../../../org/goda/time/DateTime.html">DateTime</a> getEnd();
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>      <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="83" href="#83">83</a>      <em class="jxr_javadoccomment">/**</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * Does this time interval contain the specified instant.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     * Non-zero duration intervals are inclusive of the start instant and</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     * exclusive of the end. A zero duration interval cannot contain anything.</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">     * For example:</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains 08:59  = false (before start)</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains 09:00  = true</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains 09:59  = true</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains 10:00  = false (equals end)</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains 10:01  = false (after end)</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">     * </em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">     * [14:00 to 14:00) contains 14:00  = false (zero duration contains nothing)</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     *</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * @param instant  the instant, null means now</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * @return true if this time interval contains the instant</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     */</em>
<a name="103" href="#103">103</a>     <strong class="jxr_keyword">boolean</strong> contains(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="104" href="#104">104</a>     
<a name="105" href="#105">105</a>     <em class="jxr_javadoccomment">/**</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">     * Does this time interval contain the specified time interval.</em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">     * Non-zero duration intervals are inclusive of the start instant and</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * exclusive of the end. The other interval is contained if this interval</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * wholly contains, starts, finishes or equals it.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     * A zero duration interval cannot contain anything.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * When two intervals are compared the result is one of three states:</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * (a) they abut, (b) there is a gap between them, (c) they overlap.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     * The &lt;code&gt;contains&lt;/code&gt; method is not related to these states.</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">     * In particular, a zero duration interval is contained at the start of</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">     * a larger interval, but does not overlap (it abuts instead).</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * For example:</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:00 to 10:00)  = true</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:00 to 09:30)  = true</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:30 to 10:00)  = true</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:15 to 09:45)  = true</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:00 to 09:00)  = true</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * </em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [08:59 to 10:00)  = false (otherStart before thisStart)</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [09:00 to 10:01)  = false (otherEnd after thisEnd)</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) contains [10:00 to 10:00)  = false (otherStart equals thisEnd)</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * </em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * [14:00 to 14:00) contains [14:00 to 14:00)  = false (zero duration contains nothing)</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @param interval  the time interval to compare to, null means a zero duration interval now</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * @return true if this time interval contains the time interval</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     */</em>
<a name="137" href="#137">137</a>     <strong class="jxr_keyword">boolean</strong> contains(<a href="../../../org/goda/time/ReadableInterval.html">ReadableInterval</a> interval);
<a name="138" href="#138">138</a>     
<a name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * Does this time interval overlap the specified time interval.</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * An interval overlaps another if it shares some common part of the</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * datetime continuum. </em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * When two intervals are compared the result is one of three states:</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * (a) they abut, (b) there is a gap between them, (c) they overlap.</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     * The abuts state takes precedence over the other two, thus a zero duration</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * interval at the start of a larger interval abuts and does not overlap.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * For example:</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [08:00 to 08:30)  = false (completely before)</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [08:00 to 09:00)  = false (abuts before)</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [08:00 to 09:30)  = true</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [08:00 to 10:00)  = true</em>
<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [08:00 to 11:00)  = true</em>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * </em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:00 to 09:00)  = false (abuts before)</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:00 to 09:30)  = true</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:00 to 10:00)  = true</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:00 to 11:00)  = true</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * </em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:30 to 09:30)  = true</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:30 to 10:00)  = true</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [09:30 to 11:00)  = true</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * </em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [10:00 to 10:00)  = false (abuts after)</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [10:00 to 11:00)  = false (abuts after)</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * </em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * [09:00 to 10:00) overlaps [10:30 to 11:00)  = false (completely after)</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * </em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * [14:00 to 14:00) overlaps [14:00 to 14:00)  = false (abuts before and after)</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * [14:00 to 14:00) overlaps [13:00 to 15:00)  = true</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     *</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * @param interval  the time interval to compare to, null means a zero length interval now</em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * @return true if the time intervals overlap</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     */</em>
<a name="180" href="#180">180</a>     <strong class="jxr_keyword">boolean</strong> overlaps(<a href="../../../org/goda/time/ReadableInterval.html">ReadableInterval</a> interval);
<a name="181" href="#181">181</a>     
<a name="182" href="#182">182</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="183" href="#183">183</a>     <em class="jxr_javadoccomment">/**</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * Is this time interval after the specified instant.</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     * </em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     * @param instant  the instant to compare to, null means now</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">     * @return true if this time interval is after the instant</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     */</em>
<a name="191" href="#191">191</a>     <strong class="jxr_keyword">boolean</strong> isAfter(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="192" href="#192">192</a>     
<a name="193" href="#193">193</a>     <em class="jxr_javadoccomment">/**</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * Is this time interval entirely after the specified interval.</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * </em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * @param interval  the interval to compare to, null means now</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * @return true if this time interval is after the interval specified</em>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     */</em>
<a name="201" href="#201">201</a>     <strong class="jxr_keyword">boolean</strong> isAfter(<a href="../../../org/goda/time/ReadableInterval.html">ReadableInterval</a> interval);
<a name="202" href="#202">202</a>     
<a name="203" href="#203">203</a>     <em class="jxr_javadoccomment">/**</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * Is this time interval before the specified instant.</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     * </em>
<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">     * @param instant  the instant to compare to, null means now</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">     * @return true if this time interval is before the instant</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     */</em>
<a name="211" href="#211">211</a>     <strong class="jxr_keyword">boolean</strong> isBefore(<a href="../../../org/goda/time/ReadableInstant.html">ReadableInstant</a> instant);
<a name="212" href="#212">212</a>     
<a name="213" href="#213">213</a>     <em class="jxr_javadoccomment">/**</em>
<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">     * Is this time interval entirely before the specified interval.</em>
<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * Intervals are inclusive of the start instant and exclusive of the end.</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * </em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * @param interval  the interval to compare to, null means now</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     * @return true if this time interval is before the interval specified</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">     */</em>
<a name="221" href="#221">221</a>     <strong class="jxr_keyword">boolean</strong> isBefore(<a href="../../../org/goda/time/ReadableInterval.html">ReadableInterval</a> interval);
<a name="222" href="#222">222</a>     
<a name="223" href="#223">223</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="224" href="#224">224</a>     <em class="jxr_javadoccomment">/**</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * Get this interval as an immutable &lt;code&gt;Interval&lt;/code&gt; object.</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * This will either typecast this instance, or create a new &lt;code&gt;Interval&lt;/code&gt;.</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     *</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     * @return the interval as an Interval object</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     */</em>
<a name="231" href="#231">231</a>     <a href="../../../org/goda/time/Interval.html">Interval</a> toInterval();
<a name="232" href="#232">232</a> 
<a name="233" href="#233">233</a>     <em class="jxr_javadoccomment">/**</em>
<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * Get this time interval as a &lt;code&gt;MutableInterval&lt;/code&gt;.</em>
<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * This will always return a new &lt;code&gt;MutableInterval&lt;/code&gt; with the same interval.</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     *</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * @return the time interval as a MutableInterval object</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     */</em>
<a name="240" href="#240">240</a>     <a href="../../../org/goda/time/MutableInterval.html">MutableInterval</a> toMutableInterval();
<a name="241" href="#241">241</a> 
<a name="242" href="#242">242</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="243" href="#243">243</a>     <em class="jxr_javadoccomment">/**</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * Gets the millisecond duration of this time interval.</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     *</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @return the millisecond duration of the time interval</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the duration exceeds the capacity of a long</em>
<a name="248" href="#248">248</a> <em class="jxr_javadoccomment">     */</em>
<a name="249" href="#249">249</a>     <a href="../../../org/goda/time/Duration.html">Duration</a> toDuration();
<a name="250" href="#250">250</a> 
<a name="251" href="#251">251</a>     <em class="jxr_javadoccomment">/**</em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * Gets the millisecond duration of this time interval.</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     *</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * @return the millisecond duration of the time interval</em>
<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * @throws ArithmeticException if the duration exceeds the capacity of a long</em>
<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     */</em>
<a name="257" href="#257">257</a>     <strong class="jxr_keyword">long</strong> toDurationMillis();
<a name="258" href="#258">258</a> 
<a name="259" href="#259">259</a>     <em class="jxr_javadoccomment">/**</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     * Converts the duration of the interval to a period using the</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     * standard period type.</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     * This method should be used to exract the field values describing the</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     * difference between the start and end instants.</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     *</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * @return a time period derived from the interval</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     */</em>
<a name="268" href="#268">268</a>     <a href="../../../org/goda/time/Period.html">Period</a> toPeriod();
<a name="269" href="#269">269</a> 
<a name="270" href="#270">270</a>     <em class="jxr_javadoccomment">/**</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * Converts the duration of the interval to a period using the</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * specified period type.</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * This method should be used to exract the field values describing the</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * difference between the start and end instants.</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     *</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * @param type  the requested type of the duration, null means standard</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * @return a time period derived from the interval</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     */</em>
<a name="280" href="#280">280</a>     <a href="../../../org/goda/time/Period.html">Period</a> toPeriod(<a href="../../../org/goda/time/PeriodType.html">PeriodType</a> type);
<a name="281" href="#281">281</a> 
<a name="282" href="#282">282</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="283" href="#283">283</a>     <em class="jxr_javadoccomment">/**</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * Compares this object with the specified object for equality based</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * on start and end millis plus the chronology.</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * All ReadableInterval instances are accepted.</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * To compare the duration of two time intervals, use {@link #toDuration()}</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     * to get the durations and compare those.</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     *</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * @param readableInterval  a readable interval to check against</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * @return true if the start and end millis are equal</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     */</em>
<a name="294" href="#294">294</a>     <strong class="jxr_keyword">boolean</strong> equals(Object readableInterval);
<a name="295" href="#295">295</a> 
<a name="296" href="#296">296</a>     <em class="jxr_javadoccomment">/**</em>
<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * Gets a hash code for the time interval that is compatable with the </em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * equals method.</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     * The formula used must be as follows:</em>
<a name="301" href="#301">301</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;int result = 97;</em>
<a name="302" href="#302">302</a> <em class="jxr_javadoccomment">     * result = 31 * result + ((int) (getStartMillis() ^ (getStartMillis() &gt;&gt;&gt; 32)));</em>
<a name="303" href="#303">303</a> <em class="jxr_javadoccomment">     * result = 31 * result + ((int) (getEndMillis() ^ (getEndMillis() &gt;&gt;&gt; 32)));</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">     * result = 31 * result + getChronology().hashCode();</em>
<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">     * return result;&lt;/pre&gt;</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">     *</em>
<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * @return a hash code</em>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     */</em>
<a name="309" href="#309">309</a>     <strong class="jxr_keyword">int</strong> hashCode();
<a name="310" href="#310">310</a> 
<a name="311" href="#311">311</a>     <em class="jxr_comment">//-----------------------------------------------------------------------</em>
<a name="312" href="#312">312</a>     <em class="jxr_javadoccomment">/**</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">     * Get the value as a String in the ISO8601 interval format.</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * For example, "2004-06-09T12:30:00.000/2004-07-10T13:30:00.000".</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     *</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * @return the value as an ISO8601 string</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     */</em>
<a name="319" href="#319">319</a>     String toString();
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

